home *** CD-ROM | disk | FTP | other *** search
/ The World of Computer Software / The World of Computer Software.iso / o_qwk10.zip / SAMPLE.CFG < prev    next >
Text File  |  1992-12-31  |  15KB  |  381 lines
  1. %%%%%%%%%%%%%%%%%%%%%%%%%%%
  2. %                         %
  3. %   Sample O_QWKer.CFG    %
  4. %                         %
  5. %%%%%%%%%%%%%%%%%%%%%%%%%%%
  6. %
  7. % BBSID          Identification of the  QWK  packet.  This name  is
  8. %                limited to 8 (DOS filename) characters and must be
  9. %                chosen in a way  which can help  users to identify
  10. %                your BBS.  It should be as unique as possible.
  11. %
  12. BBSID  MidiThru
  13. %
  14. % BBSWHERE       Location of your system, to be included in the QWK
  15. % (optional)     packet  header.  This  parameter  is just  to keep
  16. %                compatibility with QWK format definition.
  17. %
  18. BBSWHERE  Aveiro, Portugal
  19. %
  20. % BBSPHONE       Data phone number of your system to be included in
  21. % (optional)     the QWK packet header.  This parameter  is just to
  22. %                keep compatibility with QWK format definition.
  23. %
  24. BBSPHONE  351-34-313554
  25. %
  26. % PRM            .PRM file.  In the  absence of this  command,  the
  27. % (optional)     door uses the  OPUS environment variable  (defined
  28. %                with SET OPUS=xxxx.PRM).
  29. %
  30. % PRM  C:\OPUS\BBS.PRM
  31. %
  32. % NEWS           News file to be included in the QWK packets.
  33. % (optional)
  34. % NEWS  C:\OPUS\QWK\NEWS.TXT
  35. %
  36. % WELCOME        ANSI screen  to be  included  in the  QWK  packets
  37. % (optional)     (it's shown at the beginning of the users off-line
  38. %                reading session).
  39. %
  40. % WELCOME  C:\OPUS\QWK\HELLO.ANS
  41. %
  42. % GOODBYE        ANSI screen  to be  included  in the  QWK  packets
  43. % (optional)     (shown to the users  at the end of their  off-line
  44. %                reading session).
  45. %
  46. % GOODBYE  C:\OPUS\QWK\BYEBYE.ANS
  47. %
  48. % NEWFILES       New files list, to be included in the QWK packets.
  49. % (optional)     This file  must be created by a  separate  program
  50. %                (not included) like Opus-Fam.
  51. %
  52. NEWFILES  C:\OPUS\FILES\NEWFILES.TXT
  53. %
  54. % BULLETINS      Bulletins directory. This directory contains files
  55. % (optional)     with names BLT-*.*,  and the inclusion  in the QWK
  56. %                packets  is based upon  the file date.  This means
  57. %                that  all new bulletins  since the users last call
  58. %                date are included in his/her packet.
  59. %
  60. % BULLETINS  C:\OPUS\BULL\
  61. %
  62. % FORCE          The user may active and deactivate several options
  63. % (optional)     in his/her O_QWKer configuration menu,  to control
  64. %                what is included in their QWK packet. This command
  65. %                exists to control the use of those options  and it
  66. %                is applicable on the following:
  67. %
  68. %                  WELCOME   always include Welcome Screen
  69. %                  GOODBYE   always include Goodbye Screen
  70. %                  NEWS      always include News file
  71. %                  NEWFILES  always include new files list
  72. %                  BULLETINS always include new bulletins
  73. %                  REPLIES   always include messages  originated by
  74. %                            the user
  75. %                  NOVICE    force Novice help level inside O_QWKer
  76. %
  77. % FORCE  NEWS
  78. %
  79. %                There is  another syntax  for this command,  which
  80. %                allows you  to force  the scan of  certain message
  81. %                areas, so that  the user  is  not allowed  to turn
  82. %                them off. That's the AREAS option.
  83. %
  84. % FORCE  AREA  1
  85. %
  86. % EXCLUDE        This command has the opposite effect of FORCE.  In
  87. % (optional)     its first syntax,  it allows you  to deny the user
  88. %                option of  scanning message base  for his/her Opus
  89. %                Alias name. For that you use the option ALIAS.
  90. %
  91. EXCLUDE  ALIAS
  92. %
  93. %                The  second syntax is  AREAS,  and  allows you  to
  94. %                define  message areas  to  be  excluded  from  the
  95. %                available  O_QWKer  areas list  to  any user  with
  96. %                privilege bellow AsstSysop.
  97. %
  98. EXCLUDE  AREAS  0 31 99
  99. %
  100. % FULLSCAN AREA  This command  makes  the message  scanning process
  101. % (optional)     ignore user pointers  and always scan all messages
  102. %                in the areas to which it is applied.
  103. %
  104. %                It  is  useful  in  an  area  where  messages  are
  105. %                frequently deleted,  such as your Local Mail area.
  106. %                In such areas, it is not difficult to have an user
  107. %                pointer directed  beyond  the last message,  which
  108. %                means  no messages will be included in the packet,
  109. %                even if there are some unread. With the full scan,
  110. %                you  guarantee  that  all  eligible  messages  are
  111. %                delivered.
  112. %
  113. %                You should  activate  a  maintenance procedure  to
  114. %                periodically erase received messages  in the areas
  115. %                that you full scan, because even received messages
  116. %                keep being included in the user packets.
  117. %
  118. % FULLSCAN  AREA  1
  119. %
  120. % PACKER TEXT
  121. % PACKER COMPRESS
  122. % PACKER UNCOMPRESS
  123. %                These  three  commands  groups  define  the packet
  124. %                compression scheme available for user selection.
  125. %
  126. %                TEXT - description shown to users
  127. %                COMPRESS -  command used to compress QWK packets
  128. %                UNCOMPRESS - command to uncompress REP packets
  129. %
  130. %                You  may define  up to  eight compression methods.
  131. %                The first one defined is used as default.
  132. %
  133. PACKER  TEXT         Zip 1.10
  134. PACKER  COMPRESS     C:\UTIL\PKZIP.EXE -U
  135. PACKER  UNCOMPRESS   C:\UTIL\PKUNZIP.EXE
  136. %
  137. % REDIRECT COMPRESSORS
  138. % (optional)     This option allows  the redirection  of compressor
  139. %                output  to  the user,  thus giving visual feedback
  140. %                while their QWK packet is being compressed.
  141. %
  142. %                When defined, it is applied to any capable defined
  143. %                compressor, like PKZIP and LHA.
  144. %
  145. %                It is automatically disabled for Local usage.
  146. %
  147. REDIRECT  COMPRESSORS
  148. %
  149. % PROTOCOL TEXT
  150. % PROTOCOL UPLOAD
  151. % PROTOCOL DOWNLOAD
  152. %                These groups of three commands define the transfer
  153. %                options available for user selection.
  154. %
  155. %                TEXT - description shown to users
  156. %                UPLOAD - batch file to upload REP packets
  157. %                DOWNLOAD - batch file to download QWK packets
  158. %
  159. %                You may  define  up to eight protocols.  The first
  160. %                one defined is used as default.
  161. %
  162. %                Please note  you must use  a  batch file,  so that
  163. %                parameters can be passed to the protocol engine.
  164. %
  165. PROTOCOL  TEXT       Zmodem (DSZ)
  166. PROTOCOL  UPLOAD     C:\OPUS\RZ.BAT
  167. PROTOCOL  DOWNLOAD   C:\OPUS\SZ.BAT
  168. %
  169. % NEWLINE        This option defines what character will be used as
  170. % (optional)     CR/LF  in  messages included  in  the packet.  All
  171. %                known off-line readers  expect  the  character "π"
  172. %                (ASCII 227 decimal), so this is the default value.
  173. %
  174. %                Changing the default implies the need of a special
  175. %                reader, but will give the possibility to work with
  176. %                codepages where char 227 may not be made available
  177. %                for separator functions (e.g. Chinese).
  178. %
  179. % NEWLINE  160
  180. %
  181. % MSGID KLUDGE   If this option is defined, all messages entered on
  182. % (optional)     Echomail areas will include a MSGID kludge.
  183. %
  184. % MSGID  KLUDGE
  185. %
  186. % SHOW KLUDGES   If this option is defined, all messages scanned to
  187. % (optional)     Sysop or AsstSysop will include Kludges, Seen-by's
  188. %                and Path lines.
  189. %
  190. % SHOW  KLUDGES
  191. %
  192. % ALTER TEARLINE
  193. % (optional)     According to FTSC documents  and Echomail Policy,
  194. %                only  one  tearline  may  appear  on  an  echomail
  195. %                message.  Nevertheless  it is not uncommon to find
  196. %                messages containing 2 or even 3 of those.  O_QWKer
  197. %                avoids deleting lines from  the  received messages
  198. %                but  will substitute  any  candidate occurrence to
  199. %                -*-
  200. %
  201. %                Going further,  there are many echomail processors
  202. %                which  do not  respect the existence of a tearline
  203. %                in the message and add another one, so this option
  204. %                will avoid the normal inclusion of a tearline, and
  205. %                will rather include:
  206. %
  207. %                 -*- Opus-CBCS x.xx via O_QWKer vxxx
  208. %
  209. %                If you use  the internal  Opus  echomail  scanner,
  210. %                forget about this option,  since you'll never need
  211. %                it.
  212. %
  213. % ALTER TEARLINE
  214. %
  215. % HELPPATH       If this option is defined, it states where O_QWKer
  216. % (optional)     will be looking for the on-line help OEC files. By
  217. %                default,  it  is  used  the path to the executable
  218. %                O_QWKer.EXE.
  219. %
  220. % HELPPATH c:\o_qwker\help
  221. %
  222. %
  223. % STATUS LINE    When this option  is defined,  a  status line will
  224. % (optional)     appear at the console,  allowing the Sysop to know
  225. %                who is using the mail door, the baudrate,  and the
  226. %                caller's remaining time inside O_QWKer.
  227. %
  228. STATUS  LINE
  229. %
  230. % TIMELIMIT      Maximum allowed time  (in minutes)  for an O_QWKer
  231. % (optional)     session. It defaults to 10 (minutes).
  232. %
  233. % TIMELIMIT  15
  234. %
  235. % IDLETIME       Maximum inactivity time (in minutes) allowed while
  236. % (optional)     inside the mail door. It defaults to 3 (minutes).
  237. %
  238. % IDLETIME  2
  239. %
  240. % REFUND         Percentage of  time used  inside  the door  to  be
  241. % (optional)     refunded to the user.  It defaults to 0%  (no time
  242. %                refunded).
  243. %
  244. % REFUND  50
  245. %
  246. % MAXMSGS        Maximum number  of messages which can  be included
  247. % (optional)     in a single QWK packet.
  248. %
  249. %                If used  with  the  PROPORTIONAL  qualifier,  this
  250. %                command refers  to  the number of messages allowed
  251. %                if the user is connected at 1200 baud, so for 2400
  252. %                it's the double the 1200 baud rate, and so on.  By
  253. %                default it assumes the fixed value of 200.
  254. %
  255. %                When O_QWKer is used  in local mode,  PROPORTIONAL
  256. %                resolves  to  2,147,483,647  so  we may say  it is
  257. %                unlimited.
  258. %
  259. MAXMSGS  300
  260. % MAXMSGS  PROPORTIONAL  100
  261. %
  262. % MAXLINES       Maximum number of lines  for each message included
  263. % (optional)     in the QWK packet. If the message is bigger, it is
  264. %                automatically split  in  chunks  (several messages
  265. %                with the same number at the reader). Default is 60
  266. %                lines.
  267. %
  268. MAXLINES  100
  269. %
  270. % LOGMODE        Detail level of the log. The options are:
  271. % (optional)
  272. %                  LOGMODE  TERSE     (light)
  273. %                  LOGMODE  VERBOSE
  274. %                  LOGMODE  TRACE     (lots of info)
  275. %
  276. %                It defaults to VERBOSE.
  277. %
  278. % LOGMODE  TERSE
  279. %
  280. % LOGFILE        O_QWKer log  filename.  It defaults to O_QWKer.LOG
  281. % (optional)     in the executable (O_QWKer.EXE) directory.
  282. %
  283. %                For multi-line  Opus installations  you should use
  284. %                one different file for each task.  You can specify
  285. %                it  by using  the standard  Opus wildcard for task
  286. %                number (##).
  287. %
  288. % LOGFILE  C:\LOG\O_QWKer.LOG
  289. LOGFILE  C:\O_QWKER\LOG##.LOG
  290. %
  291. % TEMPDIR        Directory used by O_QWKer to process packets.  All
  292. %                files in this directory are erased,  so be sure to
  293. %                define it properly.  The  TEMPDIR  value  can also
  294. %                point to a RAMdisk.
  295. %
  296. %                For multi-line Opus installations you should use a
  297. %                different directory for each task. You may specify
  298. %                it  by using  the standard  Opus wildcard for task
  299. %                number (##).
  300. %
  301. %                For security reasons TEMPDIR  defaults to the name
  302. %                \O_QWKER$.TMP  on  the  executable's  volume,  but
  303. %                please  note  this  isn't  an option  but rather a
  304. %                protection to your system.
  305. %
  306. %                A swap directory is also created inside TEMPDIR.
  307. %
  308. %  TEMPDIR  C:\TMPQWK
  309. TEMPDIR  E:\QWK##
  310. %
  311. % QWKAREA        Opus  File Area  number  or Pathname  to where QWK
  312. % (optional)     packets are  to  be moved  in case of  a  Download
  313. %                failure,  so that the user is allowed to perform a
  314. %                deferred download after quitting the mail door.
  315. %
  316. %                In your NERF.BAT file you should check if there is
  317. %                any *.QWK file on the corresponding directory  and
  318. %                erase it  after  each user logs out,  to guarantee
  319. %                that  no  one  will  be  able  to  receive packets
  320. %                belonging to another user.
  321. %
  322. %                If this option is not defined in the configuration
  323. %                file,  O_QWKer  will not try to move the packet to
  324. %                somewhere in case of Download failure.
  325. %
  326. % QWKAREA  10
  327. % QWKAREA  F:\QWKPKT
  328. %
  329. % BADPATH        DOS path where orphaned messages are stored.  This
  330. % (optional)     option  has precedence  over the BAD_ECHO pathname
  331. %                in BBS.CTL.  If neither  exist  (either BADPATH in
  332. %                .CFG file  or  Opus  BAD_ECHO)  then  the orphaned
  333. %                messages are discarded.
  334. %
  335. BADPATH  F:\BADQWK
  336. %
  337. % ASSIGN         This  command  allows  you  to use  O_QWKer across
  338. % (optional)     networks.  Although  it  exists mainly  to support
  339. %                local usage,  it applies to  both local and remote
  340. %                sessions.
  341. %
  342. %                All occurrences of  the path defined  as the first
  343. %                parameter  will be searched in  Opus  system files
  344. %                (SYSMSG.DAT,  SYSFILE.DAT)  and  processed by this
  345. %                door as being the path corresponding to the second
  346. %                parameter, just like DOS Assign command.
  347. %
  348. %                You may declare up to 5 ASSIGN paths.
  349. %
  350. % ASSIGN  C:  O:
  351. % ASSIGN  X:\OPUS\SYSTEM  C:\OPUS
  352. %
  353. % LOCALQWK       Directory  where  QWK  packets  generated in local
  354. %                mode are stored.  This is useful  to a Sysop using
  355. %                his/her off-line reader across a network.
  356. %
  357. %                Default is \O_QWKER$.LOC  on  the volume where the
  358. %                executable is installed.
  359. %
  360. LOCALQWK  N:\SLMR\QWK
  361. %
  362. % LOCALREP       Directory  where  REP packets  to  be processed in
  363. %                local mode are stored.  This is useful  to a Sysop
  364. %                using his/her off-line reader across a network.
  365. %
  366. %                Default is \O_QWKER$.LOC on the binary's volume.
  367. %
  368. LOCALREP  N:\SLMR\REP
  369. %
  370. % LOCALUSER      Name of the LASTUSxx.DAT file  to be used in local
  371. %                mode.  Be aware that if you want to take advantage
  372. %                of the auto-scan O_QWKer feature  in barefoot Opus
  373. %                installations,  you should use the name of correct
  374. %                LASTUSxx.DAT file for your keyboard mode Opus task.
  375. %
  376. LOCALUSER  C:\OPUS\LASTUS02.DAT
  377. %
  378. %%%%%%%%%%%%%%%%%
  379. % END OF Sample %
  380. %%%%%%%%%%%%%%%%%
  381.